Add execute tool API doc #11214
Merged
Add execute tool API doc #11214
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nathaliellenaa
requested review from
AMoo-Miki,
dlvenable,
epugh,
kolchfa-aws,
natebower and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
5 tasks
kolchfa-aws
added
backport 3.2
Tech review
mingshl
reviewed
Oct 13, 2025
Signed-off-by: Nathalie Jonathan <[email protected]>
Signed-off-by: Nathalie Jonathan <[email protected]>
nathaliellenaa
force-pushed
the
execute_tool
branch
from
ebf40df to
8c83c17
Compare
Signed-off-by: Nathan Bower <[email protected]>
natebower
added
Doc review
mingshl
approved these changes
Oct 13, 2025
Signed-off-by: Fanit Kolchina <[email protected]>
natebower
reviewed
Oct 13, 2025
Signed-off-by: Nathan Bower <[email protected]>
kolchfa-aws
reviewed
Oct 13, 2025
Signed-off-by: kolchfa-aws <[email protected]>
dhrubo-os
pushed a commit
to dhrubo-os/documentation-website
that referenced
this pull request
Oct 13, 2025
* Add execute tool API doc Signed-off-by: Nathalie Jonathan <[email protected]> * Address comments Signed-off-by: Nathalie Jonathan <[email protected]> * Apply suggestions from code review Signed-off-by: Nathan Bower <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Update _ml-commons-plugin/agents-tools/tools/search-index-tool.md Signed-off-by: Nathan Bower <[email protected]> * Apply suggestions from code review Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Nathalie Jonathan <[email protected]> Signed-off-by: Nathan Bower <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>
natebower
added a commit
that referenced
this pull request
Oct 14, 2025
…#11169) * Add comprehensive agentic memory API documentation for OpenSearch 3.3 - Add long-term memory APIs: search, update, delete - Add memory history APIs: search, delete - Add general memory APIs: get, update, delete, search by type - Update add-memory API to include data type memory and structured data - Update index with complete API structure - Support for conversation memory, data memory, and trace data - Include namespace-based organization and tagging system - Remove experimental warning as agentic memory is GA in 3.3 Signed-off-by: Dhrubo Saha <[email protected]> * Consolidate agentic memory APIs and update with real response examples - Remove redundant API files in favor of unified memory APIs - Delete legacy files: delete-long-term-memory.md, delete-memory-history.md, search-long-term-memory.md, search-memory-history.md, update-long-term-memory.md, search-memory.md, delete-memory.md, update-memory.md, get-memory.md - Enhance unified APIs with comprehensive examples for all memory types (sessions, working, long-term, history) - Add metadata field documentation to add-memory.md and get-memory-by-type.md - Update response examples and field documentation with actual API responses - Update index.md to reflect clean unified API structure - Fix memory type parameter names (sessions vs session) for consistency Signed-off-by: Dhrubo Saha <[email protected]> * Complete agentic memory API documentation with missing container APIs - Add missing update-memory-container.md and search-memory-container.md files - Update create-memory-container.md with advanced features from Postman collection: * Multiple strategy support (SEMANTIC, USER_PREFERENCE, SUMMARY) * Strategy configuration with llm_result_path * Index configuration (index_prefix, use_system_index) * Remove experimental warning (GA in 3.3) - Remove experimental feature reference from index.md - All APIs now match actual implementation from Postman collection Signed-off-by: Dhrubo Saha <[email protected]> * Document default llm_result_path and LLM connector requirements - Add default llm_result_path value: $.output.message.content[0].text (Bedrock Converse format) - Document LLM connector requirement for system_prompt and user_prompt parameters - Reference ml-commons PR #4283 for standardized connector format - Clarify that default is optimized for Bedrock Converse API Signed-off-by: Dhrubo Saha <[email protected]> * Address ylwu-amzn review comments - Update add-memory.md terminology: memory_type -> payload_type, conversational/data types - Add Required/Optional column format to parameter tables - Update version labels from 3.2 to 3.3 for new unified APIs - Add binary_data and tags fields with correct data types - Fix metadata field representation as string in response examples - Add detailed explanations for namespace session creation behavior - Update create-memory-container.md with system_prompt and llm_id strategy fields - Add detailed index_prefix default behavior explanation - Show multiple namespace field examples in strategy configuration Signed-off-by: Dhrubo Saha <[email protected]> * Add agentic memory cluster setting - Add plugins.ml_commons.agentic_memory_enabled setting to cluster-settings.md - Enables/disables agentic memory functionality for AI agents - Includes session, working, long-term memory, and memory history features Signed-off-by: Dhrubo Saha <[email protected]> * update path parameters Signed-off-by: Dhrubo Saha <[email protected]> * Add comprehensive agentic memory API documentation for OpenSearch 3.3 - Add long-term memory APIs: search, update, delete - Add memory history APIs: search, delete - Add general memory APIs: get, update, delete, search by type - Update add-memory API to include data type memory and structured data - Update index with complete API structure - Support for conversation memory, data memory, and trace data - Include namespace-based organization and tagging system - Remove experimental warning as agentic memory is GA in 3.3 Signed-off-by: Dhrubo Saha <[email protected]> * Consolidate agentic memory APIs and update with real response examples - Remove redundant API files in favor of unified memory APIs - Delete legacy files: delete-long-term-memory.md, delete-memory-history.md, search-long-term-memory.md, search-memory-history.md, update-long-term-memory.md, search-memory.md, delete-memory.md, update-memory.md, get-memory.md - Enhance unified APIs with comprehensive examples for all memory types (sessions, working, long-term, history) - Add metadata field documentation to add-memory.md and get-memory-by-type.md - Update response examples and field documentation with actual API responses - Update index.md to reflect clean unified API structure - Fix memory type parameter names (sessions vs session) for consistency Signed-off-by: Dhrubo Saha <[email protected]> * Complete agentic memory API documentation with missing container APIs - Add missing update-memory-container.md and search-memory-container.md files - Update create-memory-container.md with advanced features from Postman collection: * Multiple strategy support (SEMANTIC, USER_PREFERENCE, SUMMARY) * Strategy configuration with llm_result_path * Index configuration (index_prefix, use_system_index) * Remove experimental warning (GA in 3.3) - Remove experimental feature reference from index.md - All APIs now match actual implementation from Postman collection Signed-off-by: Dhrubo Saha <[email protected]> * Document default llm_result_path and LLM connector requirements - Add default llm_result_path value: $.output.message.content[0].text (Bedrock Converse format) - Document LLM connector requirement for system_prompt and user_prompt parameters - Reference ml-commons PR #4283 for standardized connector format - Clarify that default is optimized for Bedrock Converse API Signed-off-by: Dhrubo Saha <[email protected]> * Address ylwu-amzn review comments - Update add-memory.md terminology: memory_type -> payload_type, conversational/data types - Add Required/Optional column format to parameter tables - Update version labels from 3.2 to 3.3 for new unified APIs - Add binary_data and tags fields with correct data types - Fix metadata field representation as string in response examples - Add detailed explanations for namespace session creation behavior - Update create-memory-container.md with system_prompt and llm_id strategy fields - Add detailed index_prefix default behavior explanation - Show multiple namespace field examples in strategy configuration Signed-off-by: Dhrubo Saha <[email protected]> * Add agentic memory cluster setting - Add plugins.ml_commons.agentic_memory_enabled setting to cluster-settings.md - Enables/disables agentic memory functionality for AI agents - Includes session, working, long-term memory, and memory history features Signed-off-by: Dhrubo Saha <[email protected]> * update path parameters Signed-off-by: Dhrubo Saha <[email protected]> * addressed comments Signed-off-by: Dhrubo Saha <[email protected]> * addressed comments Signed-off-by: Dhrubo Saha <[email protected]> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <[email protected]> * Doc review part 2 Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Signed-off-by: Nathan Bower <[email protected]> * Doc review part 3 Signed-off-by: Fanit Kolchina <[email protected]> * Update _ml-commons-plugin/api/agentic-memory-apis/create-memory-container.md Signed-off-by: Nathan Bower <[email protected]> * Apply suggestions from code review Signed-off-by: Nathan Bower <[email protected]> * Update _ml-commons-plugin/api/agentic-memory-apis/add-memory.md Co-authored-by: Yaliang Wu <[email protected]> Signed-off-by: Nathan Bower <[email protected]> * Add execute tool API doc (#11214) * Add execute tool API doc Signed-off-by: Nathalie Jonathan <[email protected]> * Address comments Signed-off-by: Nathalie Jonathan <[email protected]> * Apply suggestions from code review Signed-off-by: Nathan Bower <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Update _ml-commons-plugin/agents-tools/tools/search-index-tool.md Signed-off-by: Nathan Bower <[email protected]> * Apply suggestions from code review Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Nathalie Jonathan <[email protected]> Signed-off-by: Nathan Bower <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> * add create-session Signed-off-by: Dhrubo Saha <[email protected]> * Review of create session Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestion from @natebower Signed-off-by: Nathan Bower <[email protected]> --------- Signed-off-by: Dhrubo Saha <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: Nathalie Jonathan <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Yaliang Wu <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathalie Jonathan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add execute tool API doc
Issues Resolved
Closes #11213
Version
3.2 +
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.